3.24.3.2 TMR2 with One-Shot Operation

This file contains API prototypes and other data types for the TMR2 driver.

This file contains deprecated macros or functions for the TMR2 driver.

This use case configures the TMR2 PLIB to generate the timer period. The period of a timer is changed at run time during each overflow event. The callback function is used to change the timer period.

After configuring the components as described above, click 'Generate' to generate the code. Then add the following code snippets to your application:

#include "mcc_generated_files/system/system.h"

/*
 * Development Board: PIC18F57Q43 Curiosity Nano Board
 * MCC Configuration:
 *     System module: HFINTOSC (64 MHz)
 *     TMR2 module: Timer Enable - False, Prescaler - 1:128, Postscaler - 1:16, TMR Interrupt Enable - False
 *     Pins module: RF3 - GPIO Output, CustomName - LED 
 */
 
#define USE_TASKS_API 1
#define POSTSCALER 16UL
#define MS_TO_TICKS(ms) (((TMR2_CLOCK_FREQ * (ms)) / 1000UL) - 1UL)
#define LED_4_MS (MS_TO_TICKS(4UL)/POSTSCALER)
#define LED_8_MS (MS_TO_TICKS(8UL)/POSTSCALER)

static void Timer_PeriodChange(void)
{ 
    static volatile bool changePeriod = false;
    LED_Toggle();
    TMR2_Stop();
    
    uint8_t maxCount = TMR2_MaxCountGet();
    uint8_t newPeriod = changePeriod ? LED_4_MS:LED_8_MS;
    
    if(maxCount > newPeriod)
    {      
        TMR2_PeriodSet(newPeriod);
    }
    else
    {
        // Invalid period
    }
    changePeriod = !changePeriod;
    TMR2_Start();
}

int main(void)
{
    SYSTEM_Initialize();

    TMR2_PeriodSet(LED_4_MS);   
    TMR2_PeriodMatchStatusClear();
    
#if USE_TASKS_API    
    TMR2_PeriodMatchCallbackRegister(Timer_PeriodChange);
#endif
    TMR2_Start();
    
    while(1)
    {
#if   USE_TASKS_API
        TMR2_Tasks();
#else
        if(1U == TMR2_PeriodMatchStatusGet())
        {
            Timer_PeriodChange();
            TMR2_PeriodMatchStatusClear();
        }
#endif
    }    
}

This use case configures the TMR2 PLIB to generate the overflow interrupt at a period of 4 ms, while toggling an LED. This use case uses the generated APIs to set the timer period.

After configuring the components as described above, click 'Generate' to generate the code. Then add the following code snippets to your application:

#include "mcc_generated_files/system/system.h"

/*
 * Development Board: PIC18F57Q43 Curiosity Nano Board
 * MCC Configuration:
 *     System module: HFINTOSC (64 MHz)
 *     TMR2 module: Timer Enable - False, Clock Source - FOSC/4, Prescaler - 1:64,  Postscaler - 1:8, TMR Interrupt Enable - True
 *     Pins module: RF3 - GPIO Output, CustomName - LED 
 */
 
#define POSTSCALER 8UL
#define MS_TO_TICKS(ms) (((TMR2_CLOCK_FREQ * (ms)) / 1000UL) - 1UL)
#define LED_4_MS  (MS_TO_TICKS(4UL)/POSTSCALER)

void Custom_Callback(void)
{
    LED_Toggle();
}

int main(void)
{
    SYSTEM_Initialize();

    const uint8_t maxCount = TMR2_MaxCountGet();
    TMR2_CounterSet(0);
    
    if(maxCount > LED_4_MS)
    {
        TMR2_PeriodSet(LED_4_MS);
    }
    else 
    {
        // Invalid period
        // Generate default timer period
        
    }
    
    TMR2_PeriodMatchCallbackRegister(Custom_Callback);
    TMR2_Start();
    
    INTERRUPT_GlobalInterruptEnable();
    
    while(1)
    {
    }    
}

This use case configures the TMR2 PLIB to wake the microcontroller (MCU) from Sleep mode every five seconds. The wake up event toggles an LED, then puts the MCU back to Sleep.

After configuring the components as described above, click 'Generate' to generate the code. Then add the following code snippets to your application:

#include "mcc_generated_files/system/system.h"

/*
 * Development Board: PIC18F57Q43 Curiosity Nano Board
 * MCC Configuration:
 *     System module: HFINTOSC (64 MHz)
 *     TMR2 module: Timer Enable - True, Clock Source - LFINTOSC, Synchronization Enable - False, Prescaler - 1:64,  Postscaler - 1:16, Requested Period - 5s, TMR Interrupt Enable - True
 *     Pins module: RF3 - GPIO Output, CustomName - LED 
 */
 
int main(void)
{
    SYSTEM_Initialize();

    // Enable the Global Interrupts 
    INTERRUPT_GlobalInterruptEnable(); 

    while(1)
    {
        LED_Toggle();
        SLEEP(); 
        
        // Add your code here to execute after exiting Sleep mode 
    }    
}

• static void TMR2_DefaultPeriodMatchCallback (void)

• void TMR2_Initialize (void)

  Initializes the Timer2 (TMR2) module. This routine must be called before any other TMR2 routines.

• void TMR2_Deinitialize (void)

  Deinitializes the TMR2 to POR values.

• void TMR2_Start (void)

  Starts the TMR2 timer.

• void TMR2_Stop (void)

  Stops the TMR2 timer.

• void TMR2_ModeSet (TMR2_HLT_MODE mode)

  Sets the Hardware Limit Timer (HLT) mode.

• void TMR2_ExtResetSourceSet (TMR2_HLT_EXT_RESET_SOURCE reset)

  Sets the HLT External Reset source.

• uint8_t TMR2_CounterGet (void)

  Returns the current counter value.

• void TMR2_CounterSet (uint8_t count)

  Sets the counter value for the TMR2 timer.

• void TMR2_PeriodSet (uint8_t periodVal)

  Sets the period count value.

• uint8_t TMR2_PeriodGet (void)

  Returns the current period count value.

• uint8_t TMR2_MaxCountGet (void)

  Returns the TMR2 maximum count value.

• bool TMR2_PeriodMatchStatusGet (void)

  Returns the status of the TMR2 Period Match Interrupt flag.

• void TMR2_PeriodMatchStatusClear (void)

  Clears the TMR2 Period Match Interrupt flag.

• void TMR2_Tasks (void)

  Performs tasks to be executed during the TMR2 period match event.

• void TMR2_PeriodMatchCallbackRegister (void(*callbackHandler)(void))

  Setter function for the TMR2 period match event.

• static void(* TMR2_PeriodMatchCallback )(void)

Driver implementation for the TMR2 module.

Driver implementation for the TMR2 Timer driver.

TMR2 Generated Driver File

TMR2 Generated Timer Driver File

• void TMR2_Initialize (void)

  Initializes the Timer2 (TMR2) module. This routine must be called before any other TMR2 routines.

• void TMR2_Deinitialize (void)

  Deinitializes the TMR2 to POR values.

• void TMR2_Start (void)

  Starts the TMR2 timer.

• void TMR2_Stop (void)

  Stops the TMR2 timer.

• uint8_t TMR2_CounterGet (void)

  Returns the current counter value.

• void TMR2_CounterSet (uint8_t count)

  Sets the counter value for the TMR2 timer.

• void TMR2_PeriodSet (uint8_t periodVal)

  Sets the period count value.

• uint8_t TMR2_PeriodGet (void)

  Returns the current period count value.

• uint8_t TMR2_MaxCountGet (void)

  Returns the TMR2 maximum count value.

• void TMR2_ModeSet (TMR2_HLT_MODE mode)

  Sets the Hardware Limit Timer (HLT) mode.

• void TMR2_ExtResetSourceSet (TMR2_HLT_EXT_RESET_SOURCE reset)

  Sets the HLT External Reset source.

• bool TMR2_PeriodMatchStatusGet (void)

  Returns the status of the TMR2 Period Match Interrupt flag.

• void TMR2_PeriodMatchStatusClear (void)

  Clears the TMR2 Period Match Interrupt flag.

• void TMR2_Tasks (void)

  Performs tasks to be executed during the TMR2 period match event.

• void TMR2_TMRInterruptEnable (void)

  Enables the TMR2 interrupt.

• void TMR2_TMRInterruptDisable (void)

  Disables the TMR2 interrupt.

• void TMR2_ISR (void)

  Interrupt Service Routine (ISR) for the TMR2 period match interrupt.

• void TMR2_PeriodMatchCallbackRegister (void(*callbackHandler)(void))

  Setter function for the TMR2 period match event.

• #define TMR2_MAX_COUNT (255U)

  Defines the TMR2 maximum count value.

• #define TMR2_CLOCK_FREQ (16000000UL)

  Defines the TMR2 prescaled clock frequency in hertz.

• #define TIMER2_MAX_COUNT TMR2_MAX_COUNT

  Defines the Custom Name for the TMR2_MAX_COUNT.

• #define TIMER2_CLOCK_FREQ TMR2_CLOCK_FREQ

  Defines the Custom Name for the TMR2_CLOCK_FREQ.

• #define Timer2_Initialize TMR2_Initialize

  Defines the Custom Name for the TMR2_Initialize API.

• #define Timer2_Deinitialize TMR2_Deinitialize

  Defines the Custom Name for the TMR2_Deinitialize API.

• #define Timer2_Start TMR2_Start

  Defines the Custom Name for the TMR2_Start API.

• #define Timer2_Stop TMR2_Stop

  Defines the Custom Name for the TMR2_Stop API.

• #define Timer2_CounterGet TMR2_CounterGet

  Defines the Custom Name for the TMR2_CounterGet API.

• #define Timer2_CounterSet TMR2_CounterSet

  Defines the Custom Name for the TMR2_CounterSet API.

• #define Timer2_PeriodSet TMR2_PeriodSet

  Defines the Custom Name for the TMR2_PeriodSet API.

• #define Timer2_MaxCountGet TMR2_MaxCountGet

  Defines the Custom Name for the TMR2_MaxCountGet API.

• #define Timer2_ModeSet TMR2_ModeSet

  Defines the Custom Name for the TMR2_ModeSet API.

• #define Timer2_ExtResetSourceSet TMR2_ExtResetSourceSet

  Defines the Custom Name for the TMR2_ExtResetSourceSet API.

• #define Timer2_PeriodMatchCallbackRegister TMR2_PeriodMatchCallbackRegister

  Defines the Custom Name for the TMR2_PeriodMatchCallbackRegister API.

• #define Timer2_PeriodMatchStatusGet TMR2_PeriodMatchStatusGet

  Defines the Custom Name for the TMR2_PeriodMatchStatusGet API.

• #define Timer2_PeriodMatchStatusClear TMR2_PeriodMatchStatusClear

  Defines the Custom Name for the TMR2_PeriodMatchStatusClear API.

• #define Timer2_TMRInterruptEnable TMR2_TMRInterruptEnable

  Defines the Custom Name for the TMR2_TMRInterruptEnable API.

• #define Timer2_TMRInterruptDisable TMR2_TMRInterruptDisable

  Defines the Custom Name for the TMR2_TMRInterruptDisable API.

• #define Timer2_ISR TMR2_ISR

  Defines the Custom Name for the TMR2_ISR API.

• #define Timer2_Tasks TMR2_Tasks

  Defines the Custom Name for the TMR2_Tasks API.

• enum TMR2_HLT_MODE { TMR2_ROP_STARTS_TMRON, TMR2_ROP_STARTS_TMRON_ERSHIGH, TMR2_ROP_STARTS_TMRON_ERSLOW, TMR2_ROP_RESETS_ERSBOTHEDGE, TMR2_ROP_RESETS_ERSRISINGEDGE, TMR2_ROP_RESETS_ERSFALLINGEDGE, TMR2_ROP_RESETS_ERSLOW, TMR2_ROP_RESETS_ERSHIGH, TMR2_OS_STARTS_TMRON, TMR2_OS_STARTS_ERSRISINGEDGE, TMR2_OS_STARTS_ERSFALLINGEDGE, TMR2_OS_STARTS_ERSBOTHEDGE, TMR2_OS_STARTS_ERSFIRSTRISINGEDGE, TMR2_OS_STARTS_ERSFIRSTFALLINGEDGE, TMR2_OS_STARTS_ERSRISINGEDGEDETECT, TMR2_OS_STARTS_ERSFALLINGEDGEDETECT, TMR2_OS_STARTS_TMRON_ERSHIGH = 0x16, TMR2_OS_STARTS_TMRON_ERSLOW = 0x17, TMR2_MS_STARTS_TMRON_ERSRISINGEDGEDETECT = 0x11, TMR2_MS_STARTS_TMRON_ERSFALLINGEDGEDETECT = 0x12, TMR2_MS_STARTS_TMRON_ERSBOTHEDGE = 0x13 }

• enum TMR2_HLT_EXT_RESET_SOURCE { TMR2_T2CKIPPS_PIN = 0x0, TMR2_TMR4_POSTSCALED = 0x2, TMR2_TMR6_POSTSCALED = 0x3, TMR2_CCP1OUT = 0x4, TMR2_CCP2OUT = 0x5, TMR2_CCP3OUT = 0x6, TMR2_PWM1_OUT1 = 0x7, TMR2_PWM1_OUT2 = 0x8, TMR2_PWM2_OUT1 = 0x9, TMR2_PWM2_OUT2 = 0xa, TMR2_PWM3_OUT1 = 0xb, TMR2_PWM3_OUT2 = 0xc, TMR2_PWM4_OUT1 = 0xd, TMR2_PWM4_OUT2 = 0xe, TMR2_CMP1OUT = 0xf, TMR2_CMP2OUT = 0x10, TMR2_ZCDOUT = 0x11, TMR2_CLC1_OUT = 0x12, TMR2_CLC2_OUT = 0x13, TMR2_CLC3_OUT = 0x14, TMR2_CLC4_OUT = 0x15, TMR2_CLC5_OUT = 0x16, TMR2_CLC6_OUT = 0x17, TMR2_CLC7_OUT = 0x18, TMR2_CLC8_OUT = 0x19, TMR2_UART1_RX_EDGE = 0x1a, TMR2_UART1_TX_EDGE = 0x1b, TMR2_UART2_RX_EDGE = 0x1c, TMR2_UART2_TX_EDGE = 0x1d, TMR2_UART3_RX_EDGE = 0x1e, TMR2_UART3_TX_EDGE = 0x1f, TMR2_UART4_RX_EDGE = 0x20, TMR2_UART4_TX_EDGE = 0x21, TMR2_UART5_RX_EDGE = 0x22, TMR2_UART5_TX_EDGE = 0x23 }

  Defines the several modes of operation of the timer with the HLT extension.

This file contains API prototypes and other data types for the TMR2 Timer driver.

TMR2 Generated Driver API Header File

TMR2 Generated Timer Driver API Header File

• #define TMR2_Read TMR2_CounterGet

  Defines the Custom Name for the TMR2_CounterGet API. The TMR2_Read will be deprecated in the future release. Use TMR2_CounterGet instead.

• #define Timer2_Read TMR2_CounterGet

  Defines the Custom Name for the TMR2_CounterGet API. The Timer2_Read will be deprecated in the future release. Use Timer2_CounterGet instead.

• #define TMR2_Write TMR2_CounterSet

  Defines the Custom Name for the TMR2_CounterSet API. The TMR2_Write will be deprecated in the future release. Use TMR2_CounterSet instead.

• #define Timer2_Write TMR2_CounterSet

  Defines the Custom Name for the TMR2_CounterSet API. The Timer2_Write will be deprecated in the future release. Use Timer2_CounterSet instead.

• #define TMR2_PeriodCountSet TMR2_PeriodSet

  Defines the Custom Name for the TMR2_PeriodSet API. The TMR2_PeriodCountSet will be deprecated in the future release. Use TMR2_PeriodSet instead.

• #define Timer2_PeriodCountSet TMR2_PeriodSet

  Defines the Custom Name for the TMR2_PeriodSet API. The Timer2_PeriodCountSet will be deprecated in the future release. Use Timer2_PeriodSet instead.

• #define TMR2_OverflowCallbackRegister TMR2_PeriodMatchCallbackRegister

  Defines the Custom Name for the TMR2_PeriodMatchCallbackRegister API. The TMR2_OverflowCallbackRegister will be deprecated in the future release. Use TMR2_PeriodMatchCallbackRegister instead.

• #define Timer2_OverflowCallbackRegister TMR2_PeriodMatchCallbackRegister

  Defines the Custom Name for the TMR2_PeriodMatchCallbackRegister API. The Timer2_OverflowCallbackRegister will be deprecated in the future release. Use Timer2_PeriodMatchCallbackRegister instead.

• static void TMR2_DefaultPeriodMatchCallback (void)

• void TMR2_Initialize (void)

  Initializes the Timer2 (TMR2) module. This routine must be called before any other TMR2 routines.

• void TMR2_Deinitialize (void)

  Deinitializes the TMR2 to POR values.

• void TMR2_Start (void)

  Starts the TMR2 timer.

• void TMR2_Stop (void)

  Stops the TMR2 timer.

• uint32_t TMR2_CounterGet (void)

  Returns the current counter value.

• void TMR2_CounterSet (uint32_t count)

  Sets the counter value.

• void TMR2_PeriodSet (uint32_t periodVal)

  Sets the period count value.

• uint32_t TMR2_PeriodGet (void)

  Returns the current period count value.

• uint32_t TMR2_MaxCountGet (void)

  Returns the TMR2 maximum count value.

• void TMR2_ISR (void)

  Interrupt Service Routine (ISR) for the TMR2 period match interrupt.

• void TMR2_PeriodMatchCallbackRegister (void(*callbackHandler)(void))

  Setter function for the TMR2 period match event.

• const struct TIMER_INTERFACE Timer2

• static void(* TMR2_PeriodMatchCallback )(void)

• void TMR2_Initialize (void)

  Initializes the Timer2 (TMR2) module. This routine must be called before any other TMR2 routines.

• void TMR2_Deinitialize (void)

  Deinitializes the TMR2 module.

• void TMR2_Start (void)

  Starts the TMR2 timer.

• void TMR2_Stop (void)

  Stops the TMR2 timer.

• uint32_t TMR2_CounterGet (void)

  Returns the current counter value.

• void TMR2_CounterSet (uint32_t count)

  Sets the counter value.

• void TMR2_PeriodSet (uint32_t periodVal)

  Sets the period count value.

• uint32_t TMR2_PeriodGet (void)

  Returns the current period value.

• uint32_t TMR2_MaxCountGet (void)

  Returns the maximum count value of the timer.

• void TMR2_ISR (void)

  Interrupt Service Routine (ISR) for the TMR2 period match event.

• void TMR2_Tasks (void)

  Performs tasks to be executed during the TMR2 period match event.

• void TMR2_PeriodMatchCallbackRegister (void(*callbackHandler)(void))

  Registers a callback function for the TMR2 period match event.

• #define TMR2_MAX_COUNT (255U)

  Defines the TMR2 maximum count value.

• #define TMR2_CLOCK_FREQ (250000UL)

  Defines the TMR2 prescaled clock frequency in hertz.

• #define TIMER2_MAX_COUNT TMR2_MAX_COUNT

  Defines the Custom Name for the TMR2_MAX_COUNT.

• #define TIMER2_CLOCK_FREQ TMR2_CLOCK_FREQ

  Defines the Custom Name for the TMR2_CLOCK_FREQ.

• #define Timer2_Initialize TMR2_Initialize

  Defines the Custom Name for the TMR2_Initialize API.

• #define Timer2_Deinitialize TMR2_Deinitialize

  Defines the Custom Name for the TMR2_Deinitialize API.

• #define Timer2_Start TMR2_Start

  Defines the Custom Name for the TMR2_Start API.

• #define Timer2_Stop TMR2_Stop

  Defines the Custom Name for the TMR2_Stop API.

• #define Timer2_CounterGet TMR2_CounterGet

  Defines the Custom Name for the TMR2_CounterGet API.

• #define Timer2_CounterSet TMR2_CounterSet

  Defines the Custom Name for the TMR2_CounterSet API.

• #define Timer2_PeriodSet TMR2_PeriodSet

  Defines the Custom Name for the TMR2_PeriodSet API.

• #define Timer2_PeriodGet TMR2_PeriodGet

  Defines the Custom Name for the TMR2_PeriodGet API.

• #define Timer2_MaxCountGet TMR2_MaxCountGet

  Defines the Custom Name for the TMR2_MaxCountGet API.

• #define Timer2_PeriodMatchCallbackRegister TMR2_PeriodMatchCallbackRegister

  Defines the Custom Name for the TMR2_PeriodMatchCallbackRegister API.

• #define Timer2_ISR TMR2_ISR

  Defines the Custom Name for the TMR2_ISR API.

• #define Timer2_Tasks TMR2_Tasks

  Defines the Custom Name for the TMR2_Tasks API.

• const struct TIMER_INTERFACE Timer2