4.14.4 16-bit Timer/Counter A with PWM

This file contains the API prototypes for the TCA0 driver in Normal (16-bit) mode.

This file contains the API prototypes for the TCA0 driver in Split (8-bit) mode.

This file contains API prototypes and other datatypes for TCA module.

@Company Microchip Technology Inc.

@File Name TMR_interface.h

@Summary This is the generated header file for Timer module interfaces.

@Description This header file provides interfaces to Timer driver APIs. Generation Information : Driver Version : 1.00 The generated drivers are tested against the following: MPLAB : MPLAB X v5.40

This use case configures Timer/Counter A (TCAx) to generate an overflow interrupt at a period of 100 ms, 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" 

/* Create a pointer of the type TMR_INTERFACE and assign it to the address of the TCA0_Interface TMR_INTERFACE struct.
This enables us to get access the portable API interface, which ensures that it's easy to change the peripheral instance the timer runs on. */
const struct TMR_INTERFACE *Timer = &TCA0_Interface;

void Timer_Callback_100ms(void){
    LED_Toggle();
}

int main(void)
{
    SYSTEM_Initialize();
    Timer->TimeoutCallbackRegister(Timer_Callback_100ms);

    while(1){}    
}

The period of a timer is changed at run-time, when pushing the switch(SW) pin. The timer period is changed in the pin change interrupt request (IRQ) callback.

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"
#include <util/delay.h>
/* Create a pointer of the type TMR_INTERFACE and assign it to the address of the TCA0_Interface TMR_INTERFACE struct.
This enables us to get access to the portable API interface, ensuring that it's easy to change the peripheral instance the timer runs on. */
const struct TMR_INTERFACE *Timer = &TCA0_Interface;  

#define LED_100ms (0x30D3)
#define LED_500ms (0xF423)
volatile bool CHANGE_PERIOD = false;
volatile bool PERIOD_100ms = true;

void Timer_Callback(void)
{
    LED_Toggle();
}

void SW_Callback(void)
{
    CHANGE_PERIOD = true;
}

void Timer_Change_Frequency(void){
    Timer->Stop();
    if(PERIOD_100ms)
    {
        TCA0.SINGLE.CNT = 0x0;  //Clear the Counter register
        Timer->PeriodCountSet(LED_500ms);
        PERIOD_100ms = false;
    }
    else
    {
        TCA0.SINGLE.CNT = 0x0;   //Clear the Counter register
        Timer->PeriodCountSet(LED_100ms);
        PERIOD_100ms = true;
    }
    Timer->Start();
}

int main(void)
{
    SYSTEM_Initialize();

    Timer->TimeoutCallbackRegister(Timer_Callback);
    PB2_SetInterruptHandler(SW_Callback);
    while(1)
    {
        if(CHANGE_PERIOD)
        {
            Timer_Change_Frequency();
            _delay_ms(100);    //De-bounce delay
            CHANGE_PERIOD = false;
        }
    }
}

This use case shows how to configure TCAx to wake the microcontroller (MCU) from sleep mode every ten seconds. The wake-up interrupt callback makes the LED blink on for 100 ms, then puts the MCU back to sleep mode. No callback is used, but The TCAx interrupt wakes up the MCU, which then continues to execute code in the while loop.

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"
#include <util/delay.h>
#include <avr/sleep.h>

int main(void)
{
    SYSTEM_Initialize();

    while(1){
        LED_SetLow();     //Set LED High
        _delay_ms(100);   //100ms Delay in between LED toggle
        LED_SetHigh();    //Set LED Low
        sleep_mode();     //Put microcontroller to Sleep
    }
}

This use case shows how to generate a signal of a specified frequency on a pin.

Note: It is only possible to select a single output frequency, i.e. the frequency will be the same between output channels even when set to different values.

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"

int main(void)
{
    SYSTEM_Initialize();

    while(1){}
}

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"

int main(void)
{
    SYSTEM_Initialize();

    while(1){}
}

Generates PWM signals using timer split mode, generating two PWM waveforms on the selected Waveform Output pins:

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"

int main(void)
{
    SYSTEM_Initialize();

    while(1){}
}

• void(* Initialize )(void)

• void(* Start )(void)

• void(* Stop )(void)

• void(* PeriodCountSet )(size_t count)

• void(* TimeoutCallbackRegister )(void(*CallbackHandler)(void))

• void(* Tasks )(void)

The documentation for this struct was generated from the following file:

source/

timer_interface.h

• void TCAx_DefaultCompare0CallbackRegister (void)

• void TCAx_DefaultCompare1CallbackRegister (void)

• void TCAx_DefaultCompare2CallbackRegister (void)

• void TCAx_DefaultOverflowCallbackRegister (void)

• void TCAx_OverflowCallbackRegister (TCAx_cb_t cb)

  Interrupt Service Routine (ISR) callback function register to be called if the Overflow Interrupt flag is set.

• void TCAx_Compare0CallbackRegister (TCAx_cb_t cb)

  ISR callback function to be called if the Compare 0 Match Interrupt flag is set.

• void TCAx_Compare1CallbackRegister (TCAx_cb_t cb)

  ISR callback function to be called if the Compare 1 Match Interrupt flag is set.

• void TCAx_Compare2CallbackRegister (TCAx_cb_t cb)

  ISR callback function to be called if the Compare 2 Match Interrupt flag is set.

• ISR (TCA0_CMP0_vect)

• ISR (TCA0_CMP1_vect)

• ISR (TCA0_CMP2_vect)

• ISR (TCA0_OVF_vect)

• void TCAx_Initialize (void)

  Initializes the TCA interface.

• void TCAx_Start (void)

  Starts the 16-bit timer/counter for the TCA interface.

• void TCAx_Stop (void)

  Stops the 16-bit timer/counter for the TCA interface.

• void TCAx_Write (uint16_t timerVal)

  Writes the timer value to load to the TCA.

• uint16_t TCAx_Read (void)

  Reads the 16-bit timer/counter value for the TCA interface.

• void TCAx_EnableInterrupt (void)

  Enables the 16-bit timer/counter interrupt for the TCA interface.

• void TCAx_DisableInterrupt (void)

  Disables the 16-bit timer/counter interrupt for the TCA interface.

• void TCAx_ClearOverflowInterruptFlag (void)

  Clears the Overflow Interrupt flag after the Overflow flag set.

• bool TCAx_IsOverflowInterruptFlagSet (void)

  Checks the Overflow Interrupt flag status for the TCA interface.

• void TCAx_ClearCMP0InterruptFlag (void)

  Clears the Compare 0 Interrupt flag after the Compare 0 flag is set.

• bool TCAx_IsCMP0InterruptFlagSet (void)

  Checks the Compare 0 Interrupt flag status for the TCA interface.

• void TCAx_ClearCMP1InterruptFlag (void)

  Clears the Compare 1 Interrupt flag after the Compare 1 flag is set.

• bool TCAx_IsCMP1InterruptFlagSet (void)

  Checks the Compare 1 Interrupt flag status for the TCA interface.

• void TCAx_ClearCMP2InterruptFlag (void)

  Clears the Compare 2 Interrupt flag after the Compare 2 flag is set.

• bool TCAx_IsCMP2InterruptFlagSet (void)

  Checks the Compare 2 Interrupt flag status for the TCA interface.

• const struct TMR_INTERFACE TCAx_Interface

• void(* TCAx_CMP0_isr_cb )(void) = &TCAx_DefaultCompare0CallbackRegister

• void(* TCAx_CMP1_isr_cb )(void) = &TCAx_DefaultCompare1CallbackRegister

• void(* TCAx_CMP2_isr_cb )(void) = &TCAx_DefaultCompare2CallbackRegister

• void(* TCAx_OVF_isr_cb )(void) = &TCAx_DefaultOverflowCallbackRegister

This file contains the API implementations for TCA0 module driver in Normal (16-bit) mode.

TCA0 Generated Driver File

• void TCAx_Initialize (void)

  Initializes the TCA interface.

• void TCAx_Start (void)

  Starts the 16-bit timer/counter for the TCA interface.

• void TCAx_Stop (void)

  Stops the 16-bit timer/counter for the TCA interface.

• void TCAx_OverflowCallbackRegister (TCAx_cb_t cb)

  Interrupt Service Routine (ISR) callback function register to be called if the Overflow Interrupt flag is set.

• void TCAx_Compare0CallbackRegister (TCAx_cb_t cb)

  ISR callback function to be called if the Compare 0 Match Interrupt flag is set.

• void TCAx_Compare1CallbackRegister (TCAx_cb_t cb)

  ISR callback function to be called if the Compare 1 Match Interrupt flag is set.

• void TCAx_Compare2CallbackRegister (TCAx_cb_t cb)

  ISR callback function to be called if the Compare 2 Match Interrupt flag is set.

• void TCAx_EnableInterrupt (void)

  Enables the 16-bit timer/counter interrupt for the TCA interface.

• void TCAx_DisableInterrupt (void)

  Disables the 16-bit timer/counter interrupt for the TCA interface.

• uint16_t TCAx_Read (void)

  Reads the 16-bit timer/counter value for the TCA interface.

• void TCAx_Write (uint16_t timerVal)

  Writes the timer value to load to the TCA.

• void TCAx_ClearOverflowInterruptFlag (void)

  Clears the Overflow Interrupt flag after the Overflow flag set.

• bool TCAx_IsOverflowInterruptFlagSet (void)

  Checks the Overflow Interrupt flag status for the TCA interface.

• void TCAx_ClearCMP0InterruptFlag (void)

  Clears the Compare 0 Interrupt flag after the Compare 0 flag is set.

• bool TCAx_IsCMP0InterruptFlagSet (void)

  Checks the Compare 0 Interrupt flag status for the TCA interface.

• void TCAx_ClearCMP1InterruptFlag (void)

  Clears the Compare 1 Interrupt flag after the Compare 1 flag is set.

• bool TCAx_IsCMP1InterruptFlagSet (void)

  Checks the Compare 1 Interrupt flag status for the TCA interface.

• void TCAx_ClearCMP2InterruptFlag (void)

  Clears the Compare 2 Interrupt flag after the Compare 2 flag is set.

• bool TCAx_IsCMP2InterruptFlagSet (void)

  Checks the Compare 2 Interrupt flag status for the TCA interface.

• typedef void(* TCAx_cb_t) (void)

  Function pointer to the callback function called by TCA when operating in Normal mode. The default value is set to NULL which means that no callback function will be used.

• const struct TMR_INTERFACE TCAx_Interface

TCA0 Generated Driver API Header File

• void TCAx_DefaultHighCountCallbackRegister (void)

• void TCAx_DefaultLowCompare0CallbackRegister (void)

• void TCAx_DefaultLowCompare1CallbackRegister (void)

• void TCAx_DefaultLowCompare2CallbackRegister (void)

• void TCAx_DefaultLowCountCallbackRegister (void)

• void TCAx_HighCountCallbackRegister (TCAx_cb_t cb)

  Interrupt Service Routine (ISR) callback function register to be called when the high byte Underflow Interrupt flag is set.

• void TCAx_LowCompare0CallbackRegister (TCAx_cb_t cb)

  ISR callback function register to be called when the lower byte Compare 0 Interrupt flag is set.

• void TCAx_LowCompare1CallbackRegister (TCAx_cb_t cb)

  ISR callback function register to be called when the lower byte Compare 1 Interrupt flag is set.

• void TCAx_LowCompare2CallbackRegister (TCAx_cb_t cb)

  ISR callback function register to be called when the lower byte Compare 2 Interrupt flag is set.

• void TCAx_LowCountCallbackRegister (TCAx_cb_t cb)

  ISR callback function register to be called when the low byte Underflow Interrupt flag is set.

• ISR (TCA0_HUNF_vect)

• ISR (TCA0_LCMP0_vect)

• ISR (TCA0_LCMP1_vect)

• ISR (TCA0_LCMP2_vect)

• ISR (TCA0_LUNF_vect)

• void TCAx_Initialize (void)

  Initializes the TCA interface.

• void TCAx_Start (void)

  Starts the 16-bit timer/counter for the TCA interface.

• void TCAx_Stop (void)

  Stops the 16-bit timer/counter for the TCA interface.

• void TCAx_WriteLowCount (uint8_t timerVal)

  Writes the low 8-bit Timer/Counter2 value to load to the TCA interface.

• uint8_t TCAx_ReadLowCount (void)

  Reads the low 8-bit Timer/Counter2 value for the TCA interface.

• void TCAx_WriteHighCount (uint8_t timerVal)

  Writes the high 8-bit Timer/Counter1 value to load for the TCA interface.

• uint8_t TCAx_ReadHighCount (void)

  Reads the high 8-bit Timer/Counter1 value for the TCA interface.

• void TCAx_EnableInterrupt (void)

  Enables the 16-bit timer/counter interrupt for the TCA interface.

• void TCAx_DisableInterrupt (void)

  Disables the 16-bit timer/counter interrupt for the TCA interface.

• void TCAx_ClearHUNFInterruptFlag (void)

  Clears the high byte Underflow Interrupt flag, if the flag is set.

• bool TCAx_IsHUNFInterruptFlagSet (void)

  Checks the high byte Underflow Interrupt flag status for split timer/counter.

• void TCAx_ClearLUNFInterruptFlag (void)

  Clears the low byte Underflow Interrupt flag, if the flag is set.

• bool TCAx_IsLUNFInterruptFlagSet (void)

  Checks the low byte Underflow Interrupt flag status for split timer/counter.

• void TCAx_ClearLCMP0InterruptFlag (void)

  Clears the low byte Compare Channel 0 Interrupt Enable bit, if the flag is set for the TCA.

• bool TCAx_IsLCMP0InterruptFlagSet (void)

  Checks the low byte Compare Channel 0 Interrupt flag status for the TCA interface.

• void TCAx_ClearLCMP1InterruptFlag (void)

  Clears the low byte Compare Channel 1 Interrupt Enable bit, if the flag is set for the TCA.

• bool TCAx_IsLCMP1InterruptFlagSet (void)

  Checks the low byte Compare Channel 1 Interrupt flag status for the TCA interface.

• void TCAx_ClearLCMP2InterruptFlag (void)

  Clears the low byte Compare Channel 2 Interrupt Enable bit, if the flag is set for the TCA.

• bool TCAx_IsLCMP2InterruptFlagSet (void)

  Checks the low byte Compare Channel 2 Interrupt flag status for the TCA interface.

• const struct TMR_INTERFACE TCAx_Interface

• void(* TCAx_HCNT_isr_cb )(void) = &TCAx_DefaultHighCountCallbackRegister

• void(* TCAx_LCMP0_isr_cb )(void) = &TCAx_DefaultLowCompare0CallbackRegister

• void(* TCAx_LCMP1_isr_cb )(void) = &TCAx_DefaultLowCompare1CallbackRegister

• void(* TCAx_LCMP2_isr_cb )(void) = &TCAx_DefaultLowCompare2CallbackRegister

• void(* TCAx_LCNT_isr_cb )(void) = &TCAx_DefaultLowCountCallbackRegister

This file contains the API implementations for TCA0 module in Split (8-bit) mode.

TCA0 Generated Driver File

• void TCAx_Initialize (void)

  Initializes Split mode for the TCA interface.

• void TCAx_Start (void)

  Starts Split timer/counter for the TCA interface.

• void TCAx_Stop (void)

  Stops Split timer/counter for the TCA interface.

• void TCAx_HighCountCallbackRegister (TCAx_cb_t cb)

  Interrupt Service Routine (ISR) callback function register to be called when the high byte Underflow Interrupt flag is set.

• void TCAx_LowCompare0CallbackRegister (TCAx_cb_t cb)

  ISR callback function register to be called when the lower byte Compare 0 Interrupt flag is set.

• void TCAx_LowCompare1CallbackRegister (TCAx_cb_t cb)

  ISR callback function register to be called when the lower byte Compare 1 Interrupt flag is set.

• void TCAx_LowCompare2CallbackRegister (TCAx_cb_t cb)

  ISR callback function register to be called when the lower byte Compare 2 Interrupt flag is set.

• void TCAx_LowCountCallbackRegister (TCAx_cb_t cb)

  ISR callback function register to be called when the low byte Underflow Interrupt flag is set.

• void TCAx_EnableInterrupt (void)

  Enables the split timer/counter interrupt for the TCA interface.

• void TCAx_DisableInterrupt (void)

  Disables the split timer/counter interrupt for the TCA interface.

• uint8_t TCAx_ReadHighCount (void)

  Reads the high 8-bit Timer/Counter1 value for the TCA interface.

• void TCAx_WriteHighCount (uint8_t timerVal)

  Writes the high 8-bit Timer/Counter1 value to load for the TCA interface.

• uint8_t TCAx_ReadLowCount (void)

  Reads the low 8-bit Timer/Counter2 value for the TCA interface.

• void TCAx_WriteLowCount (uint8_t timerVal)

  Writes the low 8-bit Timer/Counter2 value to load to the TCA interface.

• void TCAx_ClearHUNFInterruptFlag (void)

  Clears the high byte Underflow Interrupt flag, if the flag is set.

• bool TCAx_IsHUNFInterruptFlagSet (void)

  Checks the high byte Underflow Interrupt flag status for split timer/counter.

• void TCAx_ClearLUNFInterruptFlag (void)

  Clears the low byte Underflow Interrupt flag, if the flag is set.

• bool TCAx_IsLUNFInterruptFlagSet (void)

  Checks the low byte Underflow Interrupt flag status for split timer/counter.

• void TCAx_ClearLCMP0InterruptFlag (void)

  Clears the low byte Compare Channel 0 Interrupt Enable bit, if the flag is set for the TCA.

• bool TCAx_IsLCMP0InterruptFlagSet (void)

  Checks the low byte Compare Channel 0 Interrupt flag status for the TCA interface.

• void TCAx_ClearLCMP1InterruptFlag (void)

  Clears the low byte Compare Channel 1 Interrupt Enable bit, if the flag is set for the TCA.

• bool TCAx_IsLCMP1InterruptFlagSet (void)

  Checks the low byte Compare Channel 1 Interrupt flag status for the TCA interface.

• void TCAx_ClearLCMP2InterruptFlag (void)

  Clears the low byte Compare Channel 2 Interrupt Enable bit, if the flag is set for the TCA.

• bool TCAx_IsLCMP2InterruptFlagSet (void)

  Checks the low byte Compare Channel 2 Interrupt flag status for the TCA interface.

• typedef void(* TCAx_cb_t) (void)

• const struct TMR_INTERFACE TCAx_Interface

TCA0 Generated Driver API Header File

• struct TMR_INTERFACE