High Speed Analog Comparator with Slope Compensation DAC driver using dsPIC MCUs. More...

Collaboration diagram for CMP DAC Driver:

Files
file	cmp1.h
	This is the generated driver header file for the CMP1 driver.

file	cmp3.h
	This is the generated driver header file for the CMP3 driver.

file	cmp1.c
	This is the generated driver source file for CMP1 driver.

file	cmp3.c
	This is the generated driver source file for CMP3 driver.

Data Structures
struct	DAC_DC_INTERFACE
	Structure containing the function pointers of DAC driver in DC mode. More...

struct	CMP_INTERFACE
	Structure containing the function pointers of CMP driver. More...

Macros
#define	CMP_DAC1_SEC_Initialize CMP1_Initialize
	This macro defines the Custom Name for CMP1_Initialize API.

#define	CMP_DAC1_SEC_Deinitialize CMP1_Deinitialize
	This macro defines the Custom Name for CMP1_Deinitialize API.

#define	CMP_DAC1_SEC_StatusGet CMP1_StatusGet
	This macro defines the Custom Name for CMP1_StatusGet API.

#define	CMP_DAC1_SEC_Enable CMP1_Enable
	This macro defines the Custom Name for CMP1_Enable API.

#define	CMP_DAC1_SEC_Disable CMP1_Disable
	This macro defines the Custom Name for CMP1_Disable API.

#define	CMP_DAC1_SEC_DACEnable CMP1_DACEnable
	This macro defines the Custom Name for CMP1_DACEnable API.

#define	CMP_DAC1_SEC_DACDisable CMP1_DACDisable
	This macro defines the Custom Name for CMP1_DACDisable API.

#define	CMP_DAC1_SEC_DACDisable CMP1_DACDisable
	This macro defines the Custom Name for CMP1_DACDisable API.

#define	CMP_DAC1_SEC_DACDataWrite CMP1_DACDataWrite
	This macro defines the Custom Name for CMP1_DACDataWrite API.

#define	CMP_DAC1_SEC_EventCallbackRegister CMP1_EventCallbackRegister
	This macro defines the Custom Name for CMP1_EventCallbackRegister API.

#define	CMP_DAC1_SEC_Tasks CMP1_Tasks
	This macro defines the Custom Name for CMP1_Tasks API.

#define	CMP_DAC3_PCT_Initialize CMP3_Initialize
	This macro defines the Custom Name for CMP3_Initialize API.

#define	CMP_DAC3_PCT_Deinitialize CMP3_Deinitialize
	This macro defines the Custom Name for CMP3_Deinitialize API.

#define	CMP_DAC3_PCT_StatusGet CMP3_StatusGet
	This macro defines the Custom Name for CMP3_StatusGet API.

#define	CMP_DAC3_PCT_Enable CMP3_Enable
	This macro defines the Custom Name for CMP3_Enable API.

#define	CMP_DAC3_PCT_Disable CMP3_Disable
	This macro defines the Custom Name for CMP3_Disable API.

#define	CMP_DAC3_PCT_DACEnable CMP3_DACEnable
	This macro defines the Custom Name for CMP3_DACEnable API.

#define	CMP_DAC3_PCT_DACDisable CMP3_DACDisable
	This macro defines the Custom Name for CMP3_DACDisable API.

#define	CMP_DAC3_PCT_DACDisable CMP3_DACDisable
	This macro defines the Custom Name for CMP3_DACDisable API.

#define	CMP_DAC3_PCT_DACDataWrite CMP3_DACDataWrite
	This macro defines the Custom Name for CMP3_DACDataWrite API.

#define	CMP_DAC3_PCT_EventCallbackRegister CMP3_EventCallbackRegister
	This macro defines the Custom Name for CMP3_EventCallbackRegister API.

Functions
void	CMP1_Initialize (void)
	Initialize the CMP1 module.

void	CMP1_Deinitialize (void)
	Deinitializes the CMP1 to POR values.

bool	CMP1_StatusGet (void)
	Returns the comparator output status.

void	CMP1_Enable (void)
	Enables the common DAC module.

void	CMP1_Disable (void)
	Disables the common DAC module.

void	CMP1_DACEnable (void)
	Enables the individual DAC module.

void	CMP1_DACDisable (void)
	Disables the individual DAC module.

void	CMP1_DACDataWrite (size_t value)
	CMP DAC Data write to register.

void	CMP1_EventCallbackRegister (void(*handler)(void))
	This function can be used to override default callback and to define custom callback for CMP1 Event event.

void	CMP1_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 CMP1_EventCallbackRegister.

void	CMP1_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.

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.

Variables
const struct CMP_INTERFACE	CMP_DAC1_SEC
	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.

const struct CMP_INTERFACE	CMP_DAC3_PCT
	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

Macro Definition Documentation

◆ CMP_DAC1_SEC_DACDataWrite

#define CMP_DAC1_SEC_DACDataWrite CMP1_DACDataWrite

Definition at line 100 of file cmp1.h.

◆ CMP_DAC1_SEC_DACDisable [1/2]

#define CMP_DAC1_SEC_DACDisable CMP1_DACDisable

Definition at line 95 of file cmp1.h.

◆ CMP_DAC1_SEC_DACDisable [2/2]

#define CMP_DAC1_SEC_DACDisable CMP1_DACDisable

Definition at line 95 of file cmp1.h.

◆ CMP_DAC1_SEC_DACEnable

#define CMP_DAC1_SEC_DACEnable CMP1_DACEnable

Definition at line 90 of file cmp1.h.

◆ CMP_DAC1_SEC_Deinitialize

#define CMP_DAC1_SEC_Deinitialize CMP1_Deinitialize

Definition at line 70 of file cmp1.h.

◆ CMP_DAC1_SEC_Disable

#define CMP_DAC1_SEC_Disable CMP1_Disable

Definition at line 85 of file cmp1.h.

◆ CMP_DAC1_SEC_Enable

#define CMP_DAC1_SEC_Enable CMP1_Enable

Definition at line 80 of file cmp1.h.

◆ CMP_DAC1_SEC_EventCallbackRegister

#define CMP_DAC1_SEC_EventCallbackRegister CMP1_EventCallbackRegister

Definition at line 110 of file cmp1.h.

◆ CMP_DAC1_SEC_Initialize

#define CMP_DAC1_SEC_Initialize CMP1_Initialize

Definition at line 65 of file cmp1.h.

◆ CMP_DAC1_SEC_StatusGet

#define CMP_DAC1_SEC_StatusGet CMP1_StatusGet

Definition at line 75 of file cmp1.h.

◆ CMP_DAC1_SEC_Tasks

#define CMP_DAC1_SEC_Tasks CMP1_Tasks

Definition at line 115 of file cmp1.h.

◆ CMP_DAC3_PCT_DACDataWrite

#define CMP_DAC3_PCT_DACDataWrite CMP3_DACDataWrite

Definition at line 100 of file cmp3.h.

◆ CMP_DAC3_PCT_DACDisable [1/2]

#define CMP_DAC3_PCT_DACDisable CMP3_DACDisable

Definition at line 95 of file cmp3.h.

◆ CMP_DAC3_PCT_DACDisable [2/2]

#define CMP_DAC3_PCT_DACDisable CMP3_DACDisable

Definition at line 95 of file cmp3.h.

◆ CMP_DAC3_PCT_DACEnable

#define CMP_DAC3_PCT_DACEnable CMP3_DACEnable

Definition at line 90 of file cmp3.h.

◆ CMP_DAC3_PCT_Deinitialize

#define CMP_DAC3_PCT_Deinitialize CMP3_Deinitialize

Definition at line 70 of file cmp3.h.

◆ CMP_DAC3_PCT_Disable

#define CMP_DAC3_PCT_Disable CMP3_Disable

Definition at line 85 of file cmp3.h.

◆ CMP_DAC3_PCT_Enable

#define CMP_DAC3_PCT_Enable CMP3_Enable

Definition at line 80 of file cmp3.h.

◆ CMP_DAC3_PCT_EventCallbackRegister

#define CMP_DAC3_PCT_EventCallbackRegister CMP3_EventCallbackRegister

Definition at line 110 of file cmp3.h.

◆ CMP_DAC3_PCT_Initialize

#define CMP_DAC3_PCT_Initialize CMP3_Initialize

Definition at line 65 of file cmp3.h.

◆ CMP_DAC3_PCT_StatusGet

#define CMP_DAC3_PCT_StatusGet CMP3_StatusGet

Definition at line 75 of file cmp3.h.

Function Documentation

◆ CMP1_DACDataWrite()

void CMP1_DACDataWrite ( size_t value )

Parameters

[in] value - DAC Data write value

Returns: none

Definition at line 136 of file cmp1.c.

◆ CMP1_DACDisable()

void CMP1_DACDisable ( void )

Parameters

none

Returns: none

Definition at line 131 of file cmp1.c.

◆ CMP1_DACEnable()

void CMP1_DACEnable ( void )

Parameters

none

Returns: none

Definition at line 126 of file cmp1.c.

◆ CMP1_Deinitialize()

void CMP1_Deinitialize ( void )

Parameters

none

Returns: none

Definition at line 91 of file cmp1.c.

◆ CMP1_Disable()

void CMP1_Disable ( void )

Parameters

none

Returns: none

Definition at line 121 of file cmp1.c.

◆ CMP1_Enable()

void CMP1_Enable ( void )

Parameters

none

Returns: none

Definition at line 116 of file cmp1.c.

◆ CMP1_EventCallback()

void CMP1_EventCallback ( void )

Parameters

none

Returns: none

Here is the caller graph for this function:

◆ CMP1_EventCallbackRegister()

void CMP1_EventCallbackRegister ( void(* handler )(void) )

Parameters

[in] handler - Address of the callback function.

Returns: none

Definition at line 141 of file cmp1.c.

Here is the caller graph for this function:

◆ CMP1_Initialize()

void CMP1_Initialize ( void )

Parameters

none

Returns: none

Definition at line 69 of file cmp1.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CMP1_StatusGet()

bool CMP1_StatusGet ( void )

Parameters

none

Returns: true - Comparator output is high; false - Comparator output is low

Definition at line 111 of file cmp1.c.

◆ CMP1_Tasks()

void CMP1_Tasks ( void )

Parameters

none

Returns: none

Definition at line 154 of file cmp1.c.

◆ CMP3_DACDataWrite()

void CMP3_DACDataWrite ( size_t value )

Parameters

[in] value - DAC Data write value

Returns: none

Definition at line 142 of file cmp3.c.

◆ CMP3_DACDisable()

void CMP3_DACDisable ( void )

Parameters

none

Returns: none

Definition at line 137 of file cmp3.c.

◆ CMP3_DACEnable()

void CMP3_DACEnable ( void )

Parameters

none

Returns: none

Definition at line 132 of file cmp3.c.

◆ CMP3_Deinitialize()

void CMP3_Deinitialize ( void )

Parameters

none

Returns: none

Definition at line 95 of file cmp3.c.

◆ CMP3_Disable()

void CMP3_Disable ( void )

Parameters

none

Returns: none

Definition at line 127 of file cmp3.c.

◆ CMP3_Enable()

void CMP3_Enable ( void )

Parameters

none

Returns: none

Definition at line 122 of file cmp3.c.

◆ CMP3_EventCallback()

void CMP3_EventCallback ( void )

Parameters

none

Returns: none

Here is the caller graph for this function:

◆ CMP3_EventCallbackRegister()

void CMP3_EventCallbackRegister ( void(* handler )(void) )

Parameters

[in] handler - Address of the callback function.

Returns: none

Definition at line 147 of file cmp3.c.

Here is the caller graph for this function:

◆ CMP3_Initialize()

void CMP3_Initialize ( void )

Parameters

none

Returns: none

Definition at line 69 of file cmp3.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CMP3_StatusGet()

bool CMP3_StatusGet ( void )

Parameters

none

Returns: true - Comparator output is high; false - Comparator output is low

Definition at line 117 of file cmp3.c.

Variable Documentation

◆ CMP_DAC1_SEC

const struct CMP_INTERFACE CMP_DAC1_SEC

extern

Definition at line 55 of file cmp1.c.

◆ CMP_DAC3_PCT

const struct CMP_INTERFACE CMP_DAC3_PCT

extern

Definition at line 55 of file cmp3.c.

		4kW dsPIC33C PSFB DC-DC DA (Part-No. )
Content

Files

Data Structures

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ CMP_DAC1_SEC_DACDataWrite

◆ CMP_DAC1_SEC_DACDisable [1/2]

◆ CMP_DAC1_SEC_DACDisable [2/2]

◆ CMP_DAC1_SEC_DACEnable

◆ CMP_DAC1_SEC_Deinitialize

◆ CMP_DAC1_SEC_Disable

◆ CMP_DAC1_SEC_Enable

◆ CMP_DAC1_SEC_EventCallbackRegister

◆ CMP_DAC1_SEC_Initialize

◆ CMP_DAC1_SEC_StatusGet

◆ CMP_DAC1_SEC_Tasks

◆ CMP_DAC3_PCT_DACDataWrite

◆ CMP_DAC3_PCT_DACDisable [1/2]

◆ CMP_DAC3_PCT_DACDisable [2/2]

◆ CMP_DAC3_PCT_DACEnable

◆ CMP_DAC3_PCT_Deinitialize

◆ CMP_DAC3_PCT_Disable

◆ CMP_DAC3_PCT_Enable

◆ CMP_DAC3_PCT_EventCallbackRegister

◆ CMP_DAC3_PCT_Initialize

◆ CMP_DAC3_PCT_StatusGet

Function Documentation

◆ CMP1_DACDataWrite()

◆ CMP1_DACDisable()

◆ CMP1_DACEnable()

◆ CMP1_Deinitialize()

◆ CMP1_Disable()

◆ CMP1_Enable()

◆ CMP1_EventCallback()

◆ CMP1_EventCallbackRegister()

◆ CMP1_Initialize()

◆ CMP1_StatusGet()

◆ CMP1_Tasks()

◆ CMP3_DACDataWrite()

◆ CMP3_DACDisable()

◆ CMP3_DACEnable()

◆ CMP3_Deinitialize()

◆ CMP3_Disable()

◆ CMP3_Enable()

◆ CMP3_EventCallback()

◆ CMP3_EventCallbackRegister()

◆ CMP3_Initialize()

◆ CMP3_StatusGet()

Variable Documentation

◆ CMP_DAC1_SEC

◆ CMP_DAC3_PCT