Bar Logo 3.8/7.6 kw Totem pole Demonstration Application (Part-No. (not specified))
 
Content
      
Loading...
Searching...
No Matches
Files | Data Structures | Macros | Functions | Variables
CMP DAC Driver
MPLABX MCC Melody Code Generator

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  cmp1.c
 This is the generated driver source file for CMP1 driver.
 
file  cmp1.h
 This is the generated driver header file for the CMP1 driver.
 
file  cmp1.c
 This is the generated driver source file for CMP1 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_Initialize   CMP1_Initialize
 This macro defines the Custom Name for CMP1_Initialize API.
 
#define CMP_DAC1_Deinitialize   CMP1_Deinitialize
 This macro defines the Custom Name for CMP1_Deinitialize API.
 
#define CMP_DAC1_StatusGet   CMP1_StatusGet
 This macro defines the Custom Name for CMP1_StatusGet API.
 
#define CMP_DAC1_Enable   CMP1_Enable
 This macro defines the Custom Name for CMP1_Enable API.
 
#define CMP_DAC1_Disable   CMP1_Disable
 This macro defines the Custom Name for CMP1_Disable API.
 
#define CMP_DAC1_DACEnable   CMP1_DACEnable
 This macro defines the Custom Name for CMP1_DACEnable API.
 
#define CMP_DAC1_DACDisable   CMP1_DACDisable
 This macro defines the Custom Name for CMP1_DACDisable API.
 
#define CMP_DAC1_DACDisable   CMP1_DACDisable
 This macro defines the Custom Name for CMP1_DACDisable API.
 
#define CMP_DAC1_DACDataWrite   CMP1_DACDataWrite
 This macro defines the Custom Name for CMP1_DACDataWrite API.
 
#define CMP_DAC1_EventCallbackRegister   CMP1_EventCallbackRegister
 This macro defines the Custom Name for CMP1_EventCallbackRegister API.
 
#define CMP_DAC1_Tasks   CMP1_Tasks
 This macro defines the Custom Name for CMP1_Tasks API.
 
#define CMP_DAC1_Initialize   CMP1_Initialize
 This macro defines the Custom Name for CMP1_Initialize API.
 
#define CMP_DAC1_Deinitialize   CMP1_Deinitialize
 This macro defines the Custom Name for CMP1_Deinitialize API.
 
#define CMP_DAC1_StatusGet   CMP1_StatusGet
 This macro defines the Custom Name for CMP1_StatusGet API.
 
#define CMP_DAC1_Enable   CMP1_Enable
 This macro defines the Custom Name for CMP1_Enable API.
 
#define CMP_DAC1_Disable   CMP1_Disable
 This macro defines the Custom Name for CMP1_Disable API.
 
#define CMP_DAC1_DACEnable   CMP1_DACEnable
 This macro defines the Custom Name for CMP1_DACEnable API.
 
#define CMP_DAC1_DACDisable   CMP1_DACDisable
 This macro defines the Custom Name for CMP1_DACDisable API.
 
#define CMP_DAC1_DACDisable   CMP1_DACDisable
 This macro defines the Custom Name for CMP1_DACDisable API.
 
#define CMP_DAC1_DACDataWrite   CMP1_DACDataWrite
 This macro defines the Custom Name for CMP1_DACDataWrite API.
 
#define CMP_DAC1_EventCallbackRegister   CMP1_EventCallbackRegister
 This macro defines the Custom Name for CMP1_EventCallbackRegister API.
 
#define CMP_DAC1_Tasks   CMP1_Tasks
 This macro defines the Custom Name for CMP1_Tasks 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.
 

Variables

const struct CMP_INTERFACE CMP_DAC1
 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_DAC1
 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_DACDataWrite [1/2]

#define CMP_DAC1_DACDataWrite   CMP1_DACDataWrite

Definition at line 100 of file cmp1.h.

◆ CMP_DAC1_DACDataWrite [2/2]

#define CMP_DAC1_DACDataWrite   CMP1_DACDataWrite

Definition at line 100 of file cmp1.h.

◆ CMP_DAC1_DACDisable [1/4]

#define CMP_DAC1_DACDisable   CMP1_DACDisable

Definition at line 95 of file cmp1.h.

◆ CMP_DAC1_DACDisable [2/4]

#define CMP_DAC1_DACDisable   CMP1_DACDisable

Definition at line 95 of file cmp1.h.

◆ CMP_DAC1_DACDisable [3/4]

#define CMP_DAC1_DACDisable   CMP1_DACDisable

Definition at line 95 of file cmp1.h.

◆ CMP_DAC1_DACDisable [4/4]

#define CMP_DAC1_DACDisable   CMP1_DACDisable

Definition at line 95 of file cmp1.h.

◆ CMP_DAC1_DACEnable [1/2]

#define CMP_DAC1_DACEnable   CMP1_DACEnable

Definition at line 90 of file cmp1.h.

◆ CMP_DAC1_DACEnable [2/2]

#define CMP_DAC1_DACEnable   CMP1_DACEnable

Definition at line 90 of file cmp1.h.

◆ CMP_DAC1_Deinitialize [1/2]

#define CMP_DAC1_Deinitialize   CMP1_Deinitialize

Definition at line 70 of file cmp1.h.

◆ CMP_DAC1_Deinitialize [2/2]

#define CMP_DAC1_Deinitialize   CMP1_Deinitialize

Definition at line 70 of file cmp1.h.

◆ CMP_DAC1_Disable [1/2]

#define CMP_DAC1_Disable   CMP1_Disable

Definition at line 85 of file cmp1.h.

◆ CMP_DAC1_Disable [2/2]

#define CMP_DAC1_Disable   CMP1_Disable

Definition at line 85 of file cmp1.h.

◆ CMP_DAC1_Enable [1/2]

#define CMP_DAC1_Enable   CMP1_Enable

Definition at line 80 of file cmp1.h.

◆ CMP_DAC1_Enable [2/2]

#define CMP_DAC1_Enable   CMP1_Enable

Definition at line 80 of file cmp1.h.

◆ CMP_DAC1_EventCallbackRegister [1/2]

#define CMP_DAC1_EventCallbackRegister   CMP1_EventCallbackRegister

Definition at line 110 of file cmp1.h.

◆ CMP_DAC1_EventCallbackRegister [2/2]

#define CMP_DAC1_EventCallbackRegister   CMP1_EventCallbackRegister

Definition at line 110 of file cmp1.h.

◆ CMP_DAC1_Initialize [1/2]

#define CMP_DAC1_Initialize   CMP1_Initialize

Definition at line 65 of file cmp1.h.

◆ CMP_DAC1_Initialize [2/2]

#define CMP_DAC1_Initialize   CMP1_Initialize

Definition at line 65 of file cmp1.h.

◆ CMP_DAC1_StatusGet [1/2]

#define CMP_DAC1_StatusGet   CMP1_StatusGet

Definition at line 75 of file cmp1.h.

◆ CMP_DAC1_StatusGet [2/2]

#define CMP_DAC1_StatusGet   CMP1_StatusGet

Definition at line 75 of file cmp1.h.

◆ CMP_DAC1_Tasks [1/2]

#define CMP_DAC1_Tasks   CMP1_Tasks

Definition at line 115 of file cmp1.h.

◆ CMP_DAC1_Tasks [2/2]

#define CMP_DAC1_Tasks   CMP1_Tasks

Definition at line 115 of file cmp1.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

Definition at line 149 of file cmp1.c.

+ Here is the caller graph for this function:

◆ CMP1_EventCallbackRegister()

void CMP1_EventCallbackRegister ( void(*)(void) handler)
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.

Variable Documentation

◆ CMP_DAC1 [1/2]

const struct CMP_INTERFACE CMP_DAC1
extern

Definition at line 55 of file cmp1.c.

◆ CMP_DAC1 [2/2]

const struct CMP_INTERFACE CMP_DAC1
extern

Definition at line 55 of file cmp1.c.