3.25 UTMR - Universal Timer

This file contains API prototypes and other data types for the TU16A module.

This use case configures the Timer module to toggle an LED on and off with specific timing intervals: 4 ms on and 8 ms off.

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: PIC18F57Q84 Curiosity Nano Board
 * MCC Configuration:
 *     System module: HFINTOSC (64 MHz)
 *     UTMR module: Timer Dependency Selector - TU16A
 *     TU16A module: Timer Enable - False, Prescaler - 9, Synchronization Enable - False, Reset Condition - At PR Match, Timer Interrupt Enable - False
 *     Pins module: RF3 - GPIO Output, CustomName - LED 
 */
 
#define USE_TASKS_API 1
#define MS_TO_TICKS(ms) (((TU16A_CLOCK_FREQ * (ms)) / 1000UL) - 1UL)
#define LED_4_MS (MS_TO_TICKS(4UL))
#define LED_8_MS (MS_TO_TICKS(8UL))

static void Timer_PeriodChange(void)
{ 
    static volatile bool changePeriod = false;
    LED_Toggle();
    TU16A_Stop();
    
    uint16_t maxCount = TU16A_MaxCountGet();
    uint16_t newPeriod = changePeriod ? LED_4_MS:LED_8_MS;
    
    if(maxCount > newPeriod)
    {      
        TU16A_PeriodSet(newPeriod);
    }
    else
    {
        // Invalid period
    }
    changePeriod = !changePeriod;
    TU16A_Start();
}

int main(void)
{
    SYSTEM_Initialize();

    TU16A_PeriodSet(LED_4_MS);   
    TU16A_InterruptFlagsClear();
    
#if USE_TASKS_API    
    TU16A_PeriodMatchCallbackRegister(Timer_PeriodChange);
#endif
    LED_SetHigh();
    TU16A_Start();
    
    while(1)
    {
#if   USE_TASKS_API
        TU16A_Tasks();
#else
        if(1U == TU16A_PeriodMatchStatusGet())
        {
            Timer_PeriodChange();
            TU16A_InterruptFlagsClear();
        }
#endif
    }    
}

This use case configures the TU16A PLIB in Chaining mode to generate the period match interrupt at a period of 1s while toggling an LED.

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: PIC18F57Q84 Curiosity Nano Board
 * MCC Configuration:
 *     System module: HFINTOSC (64 MHz)
 *     UTMR module: Enable Timer Chaining - True, Timer Dependency Selector - TU16A + TU16B
 *     TU16A module: Timer Enable - True, Clock Source - HFINTOSC, Synchronization Enable - False, Reset Condition - At PR Match, Timer Interrupt Enable - True, Period Match Interrupt Enable - True 
 *     Pins module: RF3 - GPIO Output, CustomName - LED 
 */
 
#define POSTSCALER 16UL
#define MS_TO_TICKS(ms) (((TMR0_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();
    
    TMR0_CounterSet(0);
    if(TMR0_MaxCountGet() > LED_4_MS)
    {
        TMR0_PeriodSet(LED_4_MS);
    }
    else 
    {
        //Invalid period
        //Generate default timer period
        
    }
    TMR0_PeriodMatchCallbackRegister(Custom_Callback);
    TMR0_Start();
    
    INTERRUPT_GlobalInterruptEnable();
    
    while(1)
    {
    }    
}

This use case configures the TU16A 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: PIC18F57Q84 Curiosity Nano Board
 * MCC Configuration:
 *     System module: HFINTOSC (64 MHz)
 *     TU16A module: Timer Enable - True, Clock Source - LFINTOSC, Prescaler - 2, Synchronization Enable - False, Requested Period - 5s, Reset Condition - At PR Match, Timer Interrupt Enable - True, Period Match 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 TU16A_PeriodMatchDefaultCallback (void)

• static void TU16A_ZeroMatchDefaultCallback (void)

• static void TU16A_CaptureEventDefaultCallback (void)

• void TU16A_Initialize (void)

  Initializes the TU16A module.

• void TU16A_Deinitialize (void)

  Deinitializes the TU16A module.

• void TU16A_Start (void)

  Starts the TU16A.

• void TU16A_Stop (void)

  Stops the TU16A.

• uint16_t TU16A_CaptureValueGet (void)

  Returns the captured counter value from the Timer Capture register.

• uint16_t TU16A_OnCommandCapture (void)

  Executes the capture command and returns the captured count value from the Timer Capture register.

• uint16_t TU16A_CounterGet (void)

  Returns the current counter value.

• void TU16A_CounterSet (uint16_t timerVal)

  Sets the counter value.

• void TU16A_CounterClear (void)

  Clears the Timer Counter and the internal prescaler counter to zero.

• void TU16A_PeriodSet (uint16_t periodVal)

  Sets the period value to the Timer Period register.

• uint16_t TU16A_PeriodGet (void)

  Returns the current period value.

• uint16_t TU16A_MaxCountGet (void)

  Returns the maximum count value.

• bool TU16A_PeriodMatchStatusGet (void)

  Returns the Period Match Interrupt flag status.

• bool TU16A_ResetStatusGet (void)

  Returns the Zero Interrupt flag status.

• bool TU16A_CaptureStatusGet (void)

  Returns the Capture Interrupt flag status.

• bool TU16A_RunningStatusGet (void)

  Returns the UTMR Running flag status.

• void TU16A_InterruptFlagsClear (void)

  Clears the UTMR module interrupt flags.

• void TU16A_Tasks (void)

  Performs tasks to be executed during the UTMR interrupt events.

• void TU16A_PeriodMatchCallbackRegister (void(*CallbackHandler)(void))

  Registers a callback function for the TU16A Period Match interrupt event.

• void TU16A_ZeroMatchCallbackRegister (void(*CallbackHandler)(void))

  Registers a callback function for the TU16A zero match or Reset interrupt event.

• void TU16A_CaptureEventCallbackRegister (void(*CallbackHandler)(void))

  Registers a callback function for the TU16A capture event.

• static void(* TU16A_PeriodMatchCallback )(void)

• static void(* TU16A_ZeroMatchCallback )(void)

• static void(* TU16A_CaptureEventCallback )(void)

This file contains the API definitions for the TU16A module.

This file contains the API definitions for the TU16A Timer driver.

TU16A Generated Driver File

TU16A Generated Timer Driver File

• void TU16A_Initialize (void)

  Initializes the TU16A module.

• void TU16A_Deinitialize (void)

  Deinitializes the TU16A module.

• void TU16A_Start (void)

  Starts the TU16A.

• void TU16A_Stop (void)

  Stops the TU16A.

• uint16_t TU16A_CaptureValueGet (void)

  Returns the captured counter value from the Timer Capture register.

• uint16_t TU16A_OnCommandCapture (void)

  Executes the capture command and returns the captured count value from the Timer Capture register.

• uint16_t TU16A_CounterGet (void)

  Returns the current counter value.

• void TU16A_CounterSet (uint16_t timerVal)

  Sets the counter value.

• void TU16A_CounterClear (void)

  Clears the Timer Counter and the internal prescaler counter to zero.

• void TU16A_PeriodSet (uint16_t periodVal)

  Sets the period value to the Timer Period register.

• uint16_t TU16A_PeriodGet (void)

  Returns the current period value.

• uint16_t TU16A_MaxCountGet (void)

  Returns the maximum count value.

• bool TU16A_PeriodMatchStatusGet (void)

  Returns the Period Match Interrupt flag status.

• bool TU16A_ResetStatusGet (void)

  Returns the Zero Interrupt flag status.

• bool TU16A_CaptureStatusGet (void)

  Returns the Capture Interrupt flag status.

• void TU16A_PeriodMatchInterruptEnable (void)

  Enables the period match interrupt.

• void TU16A_PeriodMatchInterruptDisable (void)

  Disables the period match interrupt.

• void TU16A_ZeroMatchInterruptEnable (void)

  Enables the zero condition match interrupt.

• void TU16A_ZeroMatchInterruptDisable (void)

  Disables the zero condition match interrupt.

• void TU16A_CaptureInterruptEnable (void)

  Enables the capture interrupt.

• void TU16A_CaptureInterruptDisable (void)

  Disables the capture interrupt.

• void TU16A_InterruptEnable (void)

  Enables the UTMR main interrupt.

• void TU16A_InterruptDisable (void)

  Disables the UTMR main interrupt.

• bool TU16A_IsInterruptEnable (void)

  Returns the status of the UTMR Interrupt Enable bit.

• bool TU16A_RunningStatusGet (void)

  Returns the UTMR Running flag status.

• void TU16A_InterruptFlagsClear (void)

  Clears the UTMR module interrupt flags.

• void TU16A_Tasks (void)

  Performs tasks to be executed during the UTMR interrupt events.

• void TU16A_ISR (void)

  Interrupt Service Routine (ISR) of the UTMR interrupts.

• void TU16A_PeriodMatchCallbackRegister (void(*CallbackHandler)(void))

  Registers a callback function for the TU16A Period Match interrupt event.

• void TU16A_ZeroMatchCallbackRegister (void(*CallbackHandler)(void))

  Registers a callback function for the TU16A zero match or Reset interrupt event.

• void TU16A_CaptureEventCallbackRegister (void(*CallbackHandler)(void))

  Registers a callback function for the TU16A capture event.

• #define TU16A_MAX_COUNT (0xFFFFU)

  Defines the maximum count of the timer.

• #define TU16A_CLOCK_FREQ (64000000UL)

  Defines the timer prescaled clock frequency in hertz.

This file contains the deprecated macros or APIs for the TU16A driver.

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

TU16A Generated Driver API Header File

TU16A Generated Driver API Header File

""

TU16A Generated Timer Driver API Header File

• #define TU16A_Write TU16A_CounterSet

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

• #define TU16A_Read TU16A_CounterGet

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

• #define TU16A_CaptureValueRead TU16A_CaptureValueGet

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

• #define TU16A_PeriodValueSet TU16A_PeriodSet

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

• #define TU16A_IsTimerRunning TU16A_RunningStatusGet

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

• #define TU16A_HasPRMatchOccured TU16A_PeriodMatchStatusGet

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

• #define TU16A_HasResetOccured TU16A_ResetStatusGet

  Defines the Custom Name for the TU16A_PeriodMatchStatusGet API. The TU16A_HasResetOccured will be deprecated in the future release. Use TU16A_ResetStatusGet instead.

• #define TU16A_HasCaptureOccured TU16A_CaptureStatusGet

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

• #define TU16A_PRMatchInterruptHandlerSet TU16A_PeriodMatchCallbackRegister

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

• #define TU16A_ZeroMatchInterruptHandlerSet TU16A_ZeroMatchCallbackRegister

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

• #define TU16A_CaptureMatchInterruptHandlerSet TU16A_CaptureEventCallbackRegister

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

• static void TU16A_PeriodMatchDefaultCallback (void)

• void TU16A_Initialize (void)

  Initializes the TU16A module.

• void TU16A_Deinitialize (void)

  Deinitializes the TU16A module.

• void TU16A_Start (void)

  Starts the TU16A.

• void TU16A_Stop (void)

  Stops the TU16A.

• uint32_t TU16A_CounterGet (void)

  Returns the current counter value.

• void TU16A_CounterSet (uint32_t timerVal)

  Sets the count value to the Timer Counter register.

• void TU16A_PeriodSet (uint32_t prVal)

  Sets the timer period count to the Timer Period register.

• uint32_t TU16A_PeriodGet (void)

  Returns the current period value.

• uint32_t TU16A_MaxCountGet (void)

  Returns the maximum count value.

• void TU16A_ISR (void)

  Interrupt Service Routine (ISR) of the UTMR interrupts.

• void TU16A_PeriodMatchCallbackRegister (void(*CallbackHandler)(void))

  Registers a callback function for the TU16A Period Match interrupt event.

• const struct TIMER_INTERFACE myTimer

• static void(* TU16A_PeriodMatchCallback )(void) = TU16A_PeriodMatchDefaultCallback

• void TU16A_Initialize (void)

  Initializes the TU16A module. This routine must be called before any other TU16A routines.

• void TU16A_Deinitialize (void)

  Deinitializes the TU16A module.

• void TU16A_Start (void)

  Starts the TU16A timer.

• void TU16A_Stop (void)

  Stops the TU16A timer.

• uint32_t TU16A_CounterGet (void)

  Returns the current count value from the Timer Counter register.

• void TU16A_CounterSet (uint32_t timerVal)

  Sets the count value to the Timer Counter register.

• void TU16A_PeriodSet (uint32_t periodVal)

  Sets the timer period count to the Timer Period register.

• uint32_t TU16A_PeriodGet (void)

  Returns the TU16A period count value.

• uint32_t TU16A_MaxCountGet (void)

  Returns the TU16A maximum count value.

• void TU16A_ISR (void)

  Timer Interrupt Service Routine (ISR) for the TU16A interrupt events.

• void TU16A_Tasks (void)

  Performs the tasks to be executed during timer interrupt events.

• void TU16A_PeriodMatchCallbackRegister (void(*CallbackHandler)(void))

  Setter function for the Timer period match callback.

• #define TU16A_MAX_COUNT (65535U)

  Defines the maximum count of the timer.

• #define TU16A_CLOCK_FREQ (64000000UL)

  Defines the TU16A prescaled clock frequency in hertz.

• #define MYTIMER_MAX_COUNT TU16A_MAX_COUNT

  Defines the Custom Name for the TU16A_MAX_COUNT.

• #define MYTIMER_CLOCK_FREQ TU16A_CLOCK_FREQ

  Defines the Custom Name for the TU16A_CLOCK_FREQ.

• #define myTimer_Initialize TU16A_Initialize

  Defines the Custom Name for the TU16A_Initialize API.

• #define myTimer_Deinitialize TU16A_Deinitialize

  Defines the Custom Name for the TU16A_Deinitialize API.

• #define myTimer_Start TU16A_Start

  Defines the Custom Name for the TU16A_Start API.

• #define myTimer_Stop TU16A_Stop

  Defines the Custom Name for the TU16A_Stop API.

• #define myTimer_CounterGet TU16A_CounterGet

  Defines the Custom Name for the TU16A_CounterGet API.

• #define myTimer_CounterSet TU16A_CounterSet

  Defines the Custom Name for the TU16A_CounterSet API.

• #define myTimer_PeriodSet TU16A_PeriodSet

  Defines the Custom Name for the TU16A_PeriodSet API.

• #define myTimer_PeriodGet TMR2_PeriodGet

  Defines the Custom Name for the TMR2_PeriodGet API.

• #define myTimer_MaxCountGet TU16A_MaxCountGet

  Defines the Custom Name for the TU16A_MaxCountGet API.

• #define myTimer_ISR TU16A_ISR

  Defines the Custom Name for the TU16A_ISR API.

• #define myTimer_Tasks TU16A_Tasks

  Defines the Custom Name for the TU16A_Tasks API.

• #define myTimer_PeriodMatchCallbackRegister TU16A_PeriodMatchCallbackRegister

  Defines the Custom Name for the TU16A_PeriodMatchCallbackRegister API.

• const struct TIMER_INTERFACE Timer1