sccp1.h File Reference

This is the generated driver header file for the SCCP1-TIMER driver. More...

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

Include dependency graph for sccp1.h:

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

Go to the source code of this file.

Macros
#define	CTRLLOOP_EXE_Initialize   SCCP1_Timer_Initialize
	This macro defines the Custom Name for SCCP1_Timer_Initialize API.
#define	CTRLLOOP_EXE_Deinitialize   SCCP1_Timer_Deinitialize
	This macro defines the Custom Name for SCCP1_Timer_Deinitialize API.
#define	CTRLLOOP_EXE_Tasks   SCCP1_Timer_Tasks
	This macro defines the Custom Name for SCCP1_Timer_Tasks API.
#define	CTRLLOOP_EXE_Start   SCCP1_Timer_Start
	This macro defines the Custom Name for SCCP1_Timer_Start API.
#define	CTRLLOOP_EXE_Stop   SCCP1_Timer_Stop
	This macro defines the Custom Name for SCCP1_Timer_Stop API.
#define	CTRLLOOP_EXE_PeriodSet   SCCP1_Timer_PeriodSet
	This macro defines the Custom Name for SCCP1_Timer_PeriodSet API.
#define	CTRLLOOP_EXE_PeriodGet   SCCP1_Timer_PeriodGet
	This macro defines the Custom Name for SCCP1_Timer_PeriodGet API.
#define	CTRLLOOP_EXE_CounterGet   SCCP1_Timer_CounterGet
	This macro defines the Custom Name for SCCP1_Timer_CounterGet API.
#define	CTRLLOOP_EXE_Counter16BitGet   SCCP1_Timer_Counter16BitGet
	This macro defines the Custom Name for SCCP1_Timer_Counter16BitGet API.
#define	CTRLLOOP_EXE_InterruptPrioritySet   SCCP1_Timer_InterruptPrioritySet
	This macro defines the Custom Name for SCCP1_Timer_InterruptPrioritySet API.
#define	CTRLLOOP_EXE_TimeoutCallbackRegister   SCCP1_Timer_TimeoutCallbackRegister
	This macro defines the Custom Name for SCCP1_Timer_TimeoutCallbackRegister API.

Functions
void	SCCP1_Timer_Initialize (void)
	Initializes the SCCP1 module.
void	SCCP1_Timer_Deinitialize (void)
	Deinitializes the SCCP1 to POR values.
void	SCCP1_Timer_Start (void)
	Starts the timer.
void	SCCP1_Timer_Stop (void)
	Stops the timer.
void	SCCP1_Timer_PeriodSet (uint32_t count)
	Sets the SCCP1-Timer period count value.
static uint32_t	SCCP1_Timer_PeriodGet (void)
	This inline function gets the SCCP1-Timer period count value.
static uint32_t	SCCP1_Timer_CounterGet (void)
	This inline function gets the SCCP1-Timer elapsed count value.
static uint16_t	SCCP1_Timer_Counter16BitGet (void)
	This inline function gets the SCCP1-Timer least significant 16 bit elapsed count value.
void	SCCP1_Timer_InterruptPrioritySet (enum INTERRUPT_PRIORITY priority)
	Sets the Interrupt Priority Value.
void	SCCP1_Timer_TimeoutCallbackRegister (void(*handler)(void))
	This function can be used to override default callback and to define custom callback for SCCP1 Timeout event.
void	SCCP1_TimeoutCallbackRegister (void *handler) __attribute__((deprecated("\nThis will be removed in future MCC releases. \nUse SCCP1_Timer_TimeoutCallbackRegister instead. ")))
	This function can be used to override default callback and to define custom callback for SCCP1 Timeout event.
void	SCCP1_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 SCCP1_Timer_TimeoutCallbackRegister.

Variables
const struct TIMER_INTERFACE	CTRLLOOP_EXE
	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

SCCP1-TIMER Generated Driver Header File

Definition in file sccp1.h.