tmr1.h File Reference

This is the generated driver header file for the TMR1 driver. More...

#include <stddef.h>
#include <stdint.h>
#include <xc.h>
#include "timer_interface.h"

Include dependency graph for tmr1.h:

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

Go to the source code of this file.

Macros
#define	Timer1_Initialize   TMR1_Initialize
	This macro defines the Custom Name for TMR1_Initialize API.
#define	Timer1_Deinitialize   TMR1_Deinitialize
	This macro defines the Custom Name for TMR1_Deinitialize API.
#define	Timer1_Tasks   TMR1_Tasks
	This macro defines the Custom Name for TMR1_Tasks API.
#define	Timer1_Start   TMR1_Start
	This macro defines the Custom Name for TMR1_Start API.
#define	Timer1_Stop   TMR1_Stop
	This macro defines the Custom Name for TMR1_Stop API.
#define	Timer1_PeriodSet   TMR1_PeriodSet
	This macro defines the Custom Name for TMR1_PeriodSet API.
#define	Timer1_PeriodGet   TMR1_PeriodGet
	This macro defines the Custom Name for TMR1_PeriodGet API.
#define	Timer1_CounterGet   TMR1_CounterGet
	This macro defines the Custom Name for TMR1_CounterGet API.
#define	Timer1_Counter16BitGet   TMR1_Counter16BitGet
	This macro defines the Custom Name for TMR1_Counter16BitGet API.
#define	Timer1_InterruptPrioritySet   TMR1_InterruptPrioritySet
	This macro defines the Custom Name for TMR1_InterruptPrioritySet API.
#define	Timer1_TimeoutCallbackRegister   TMR1_TimeoutCallbackRegister
	This macro defines the Custom Name for TMR1_TimeoutCallbackRegister API.

Functions
void	TMR1_Initialize (void)
	Initializes the TMR1 module.
void	TMR1_Deinitialize (void)
	Deinitializes the TMR1 to POR values.
void	TMR1_Tasks (void)
	This function is used to implement the tasks for polled implementations.
void	TMR1_Start (void)
	Starts the timer.
void	TMR1_Stop (void)
	Stops the timer.
void	TMR1_PeriodSet (uint32_t count)
	Sets the TMR1 period count value.
static uint32_t	TMR1_PeriodGet (void)
	This inline function gets the TMR1 period count value.
static uint32_t	TMR1_CounterGet (void)
	This inline function gets the TMR1 elapsed time value.
static uint16_t	TMR1_Counter16BitGet (void)
	This inline function gets the 16 bit TMR1 elapsed time value.
void	TMR1_InterruptPrioritySet (enum INTERRUPT_PRIORITY priority)
	Sets the TMR1 interrupt priority value.
void	TMR1_TimeoutCallbackRegister (void(*handler)(void))
	This function can be used to override default callback and to define custom callback for TMR1 Timeout event.
void	TMR1_TimeoutCallback (void)
	This is the default callback with weak attribute. The user can override and implement the default callback without weak attribute or can register a custom callback function using TMR1_TimeoutCallbackRegister.

Variables
const struct TIMER_INTERFACE	Timer1
	Structure object of type TIMER_INTERFACE with the custom name given by the user in the Melody Driver User interface. The default name e.g. Timer1 can be changed by the user in the TIMER user interface. This allows defining a structure with application specific name using the 'Custom Name' field. Application specific name allows the API Portability.

Detailed Description

TMR1 Generated Driver Header File

Definition in file tmr1.h.

Function Documentation

TMR1_Counter16BitGet()

static uint16_t TMR1_Counter16BitGet ( void )

inlinestatic

Parameters

none

Returns

16 bit elapsed count value of the timer

Definition at line 205 of file tmr1.h.

TMR1_CounterGet()

static uint32_t TMR1_CounterGet ( void )

inlinestatic

Parameters

none

Returns

Elapsed count value of the timer

Definition at line 194 of file tmr1.h.

TMR1_PeriodGet()

static uint32_t TMR1_PeriodGet ( void )

inlinestatic

Parameters

none

Returns

Number of clock counts

Definition at line 183 of file tmr1.h.