cmp3.h File Reference

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

#include <stddef.h>
#include <stdbool.h>
#include "cmp_interface.h"

Include dependency graph for cmp3.h:

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

Go to the source code of this file.

Macros
#define	CMP_IPRI_SC_Initialize   CMP3_Initialize
	This macro defines the Custom Name for CMP3_Initialize API.
#define	CMP_IPRI_SC_Deinitialize   CMP3_Deinitialize
	This macro defines the Custom Name for CMP3_Deinitialize API.
#define	CMP_IPRI_SC_StatusGet   CMP3_StatusGet
	This macro defines the Custom Name for CMP3_StatusGet API.
#define	CMP_IPRI_SC_Enable   CMP3_Enable
	This macro defines the Custom Name for CMP3_Enable API.
#define	CMP_IPRI_SC_Disable   CMP3_Disable
	This macro defines the Custom Name for CMP3_Disable API.
#define	CMP_IPRI_SC_DACEnable   CMP3_DACEnable
	This macro defines the Custom Name for CMP3_DACEnable API.
#define	CMP_IPRI_SC_DACDisable   CMP3_DACDisable
	This macro defines the Custom Name for CMP3_DACDisable API.
#define	CMP_IPRI_SC_DACDataWrite   CMP3_DACDataWrite
	This macro defines the Custom Name for CMP3_DACDataWrite API.
#define	CMP_IPRI_SC_DACDisable   CMP3_DACDisable
	This macro defines the Custom Name for CMP3_DACDisable API.
#define	CMP_IPRI_SC_EventCallbackRegister   CMP3_EventCallbackRegister
	This macro defines the Custom Name for CMP3_EventCallbackRegister API.
#define	CMP_IPRI_SC_Tasks   CMP3_Tasks
	This macro defines the Custom Name for CMP3_Tasks API.

Functions
void	CMP3_Initialize (void)
	Initialize the CMP3 module.
void	CMP3_Deinitialize (void)
	Deinitializes the CMP3 to POR values.
bool	CMP3_StatusGet (void)
	Returns the comparator output status.
void	CMP3_Enable (void)
	Enables the common DAC module.
void	CMP3_Disable (void)
	Disables the common DAC module.
void	CMP3_DACEnable (void)
	Enables the individual DAC module.
void	CMP3_DACDisable (void)
	Disables the individual DAC module.
void	CMP3_DACDataWrite (size_t value)
	CMP DAC Data write to register.
void	CMP3_EventCallbackRegister (void(*handler)(void))
	This function can be used to override default callback and to define custom callback for CMP3 Event event.
void	CMP3_EventCallback (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 CMP3_EventCallbackRegister.
void	CMP3_Tasks (void)
	The Task function can be called in the main application using the High Speed Comparator, when interrupts are not used. This would thus introduce the polling mode feature of the Analog Comparator.

Variables
const struct CMP_INTERFACE	CMP_IPRI_SC
	Structure object of type CMP_INTERFACE with the custom name given by the user in the Melody Driver User interface. The default name e.g. CMP_DAC1 can be changed by the user in the CMP 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

CMP3 Generated Driver Header File

Definition in file cmp3.h.