Bar Logo Dual Active Bridge Development Board (Part-No. )
 
Content
     
Loading...
Searching...
No Matches
cmp3.h
Go to the documentation of this file.
1
17/*
18© [2024] Microchip Technology Inc. and its subsidiaries.
19
20 Subject to your compliance with these terms, you may use Microchip
21 software and any derivatives exclusively with Microchip products.
22 You are responsible for complying with 3rd party license terms
23 applicable to your use of 3rd party software (including open source
24 software) that may accompany Microchip software. SOFTWARE IS ?AS IS.?
25 NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS
26 SOFTWARE, INCLUDING ANY IMPLIED WARRANTIES OF NON-INFRINGEMENT,
27 MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT
28 WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE,
29 INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY
30 KIND WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF
31 MICROCHIP HAS BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE
32 FORESEEABLE. TO THE FULLEST EXTENT ALLOWED BY LAW, MICROCHIP?S
33 TOTAL LIABILITY ON ALL CLAIMS RELATED TO THE SOFTWARE WILL NOT
34 EXCEED AMOUNT OF FEES, IF ANY, YOU PAID DIRECTLY TO MICROCHIP FOR
35 THIS SOFTWARE.
36*/
37
38#ifndef CMP3_H
39#define CMP3_H
40
41// Section: Included Files
42
43#include <stddef.h>
44#include <stdbool.h>
45#include "cmp_interface.h"
46
47// Section: Data Type Definitions
48
59extern const struct CMP_INTERFACE CMP_IPRI_SC;
60
65#define CMP_IPRI_SC_Initialize CMP3_Initialize
70#define CMP_IPRI_SC_Deinitialize CMP3_Deinitialize
75#define CMP_IPRI_SC_StatusGet CMP3_StatusGet
80#define CMP_IPRI_SC_Enable CMP3_Enable
85#define CMP_IPRI_SC_Disable CMP3_Disable
90#define CMP_IPRI_SC_DACEnable CMP3_DACEnable
95#define CMP_IPRI_SC_DACDisable CMP3_DACDisable
100#define CMP_IPRI_SC_DACDataWrite CMP3_DACDataWrite
105#define CMP_IPRI_SC_DACDisable CMP3_DACDisable
110#define CMP_IPRI_SC_EventCallbackRegister CMP3_EventCallbackRegister
115#define CMP_IPRI_SC_Tasks CMP3_Tasks
116
117// Section: CMP3 Module APIs
118
126void CMP3_Initialize(void);
127
134void CMP3_Deinitialize(void);
135
143bool CMP3_StatusGet(void);
144
151void CMP3_Enable(void);
152
159void CMP3_Disable(void);
160
167void CMP3_DACEnable(void);
168
175void CMP3_DACDisable(void);
176
183void CMP3_DACDataWrite(size_t value);
184
192void CMP3_EventCallbackRegister(void (*handler)(void));
193
204
213void CMP3_Tasks(void);
214
215#endif //CMP3_H
216
void CMP3_EventCallback(void)
This is the default callback with weak attribute. The user can override and implement the default cal...
void CMP3_EventCallbackRegister(void(*handler)(void))
This function can be used to override default callback and to define custom callback for CMP3 Event e...
Definition cmp3.c:141
bool CMP3_StatusGet(void)
Returns the comparator output status.
Definition cmp3.c:111
void CMP3_Enable(void)
Enables the common DAC module.
Definition cmp3.c:116
void CMP3_Tasks(void)
The Task function can be called in the main application using the High Speed Comparator,...
Definition cmp3.c:154
void CMP3_Disable(void)
Disables the common DAC module.
Definition cmp3.c:121
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 Us...
Definition cmp3.c:55
void CMP3_DACDataWrite(size_t value)
CMP DAC Data write to register.
Definition cmp3.c:136
void CMP3_Deinitialize(void)
Deinitializes the CMP3 to POR values.
Definition cmp3.c:91
void CMP3_Initialize(void)
Initialize the CMP3 module.
Definition cmp3.c:69
void CMP3_DACEnable(void)
Enables the individual DAC module.
Definition cmp3.c:126
void CMP3_DACDisable(void)
Disables the individual DAC module.
Definition cmp3.c:131
Structure containing the function pointers of CMP driver.